home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 June / CHIP_CD_2004-06.iso / software / miranda_hit / files / mirinstsetup.exe / Miranda Installer 0.0.1.2 / Syntax.txt < prev    next >
Encoding:
Text File  |  2004-04-20  |  3.1 KB  |  72 lines
  1. To outline the syntax of the installation script, here's the format:
  2.  
  3. <?xml version="1.0" encoding="ISO-8859-1" ?>
  4. <installscript>
  5.  <info>
  6.   <name>Name of addon</name>
  7.   <author>Author of addon</author>
  8.   <version>Version of addon</version>
  9.   <type>[plugin | icon | sound | langpack | tool | source | doc | skin | nightly]</type> <!-- type of addon -->
  10.  </info>
  11.  
  12.  <!-- below are installation packages
  13.  the addon must have at least one package, which is the main one -->
  14.  
  15.  <!-- files that are in the zip but are not mentioned in any of the packages, will not be installed at all, so keep that in mind! -->
  16.  <packageinfo>
  17.   <optional/> <!-- optional tag, pretty much tells that the package is optional (Notice the tag is empty - i.e. No start/end pair) -->
  18.   <title>Title of package</title> <!-- This is the title of the package, can be whatever you want -->
  19.   <file>file1.dll</file> <!-- installation files. "file1.dll" means the file is in the root of the zip archive, use the relative path as well if it's in a relative path (i.e. "somefolder\test1.dll") -->
  20.   <file>file2.dll</file>
  21.  </packageinfo>
  22.  
  23.  <autorun> <!-- The autorun tag is only allowed once! i.e. One file to be executed per installation, tops :) -->
  24.   <file>somefile.txt</file>
  25.   <document/> <!-- Means the type of file is a document (Text - .txt, or HTML - .htm/.html). if this is ommitted, the user will always be asked for confirmation -->
  26.  </autorun>
  27. </installscript>
  28.  
  29.  
  30.  
  31. Tags are case-sensitive (XML Specs), just make sure you keep them at lower case.
  32. Content, such as in the <type></type> pair, is case-insensitive, you can also use comments in the XML if you wish.
  33. If you're not sure the XML is well built, you should run it through an XML validator first (Try: http://www.stg.brown.edu/service/xmlvalid/).
  34. The script must be saved as InstallScript.xml, and be in the root of the zip archive.
  35.  
  36. Note: Comments *MUST NOT* be used where data is expected, i.e. don't do this:
  37. <author>Me <!-- This is my name --></author>
  38. It won't work. However, this is ok:
  39. <info> <!-- Info about the installation -->
  40.  <name>...</name>
  41.  ...
  42. </info>
  43.  
  44. ---------------------------------------------------
  45.  
  46. Extensions for different types of installations:
  47.  
  48. *.mir - Plugin (Keeping it consistent with PluginInstaller)
  49. *.min - Nightly
  50. *.mii - Icon
  51. *.mis - Sound
  52. *.mil - Language Pack
  53. *.mit - Tool
  54. *.mio - Source
  55. *.mic - Documentation
  56. *.mik - Skin/Background Image and such
  57.  
  58. All of the above can have installation scripts
  59. ---------------------------------------------------
  60.  
  61. Parameters when running Miranda Installer:
  62.  
  63. MirInst.exe [/directory | /silent | /restart] [directory/filename]
  64.  
  65. /directory : Installs all packages inside the given directory
  66. /silent : Starts the specified installation immediatly, with no delay, and exits with no delay (unless some error has occured) when done
  67. /restart : Only works in conjuction with /silent, starts Miranda when MirInst exits
  68.  
  69. Note: Directory/Filename *MUST* be an absolute path, no relative stuff.
  70.  
  71. e.g. MirInstaller.exe /silent c:\someplugin.mir
  72.      MirInstaller.exe /silent /directory "e:\addonstoinstall"